<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />

	<title>Class Session | sweetphp</title>

	<script type="text/javascript" src="resources/combined.js?2802521858"></script>
	<script type="text/javascript" src="elementlist.js?3776638906"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Packages</h3>
			<ul>
				<li><a href="package-PHP.html">PHP</a>
						</li>
				<li class="active"><a href="package-SweetPHP.html">SweetPHP<span></span></a>
						<ul>
				<li class="active"><a href="package-SweetPHP.System.html">System<span></span></a>
						<ul>
				<li><a href="package-SweetPHP.System.Core.html">Core</a>
						</li>
				<li><a href="package-SweetPHP.System.Test.html">Test</a>
						</li>
				<li class="active"><a href="package-SweetPHP.System.Utility.html">Utility</a>
						</li>
							</ul></li></ul></li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-DataParam.html">DataParam</a></li>
				<li><a href="class-DateNow.html">DateNow</a></li>
				<li><a href="class-Dir.html">Dir</a></li>
				<li><a href="class-Float.html">Float</a></li>
				<li><a href="class-Form.html">Form</a></li>
				<li><a href="class-Helpers.html">Helpers</a></li>
				<li><a href="class-InputText.html">InputText</a></li>
				<li><a href="class-Integer.html">Integer</a></li>
				<li><a href="class-Logger.html">Logger</a></li>
				<li><a href="class-Mask.html">Mask</a></li>
				<li><a href="class-SEO.html">SEO</a></li>
				<li class="active"><a href="class-Session.html">Session</a></li>
				<li><a href="class-String.html">String</a></li>
			</ul>





		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="package-SweetPHP.System.Utility.html" title="Summary of SweetPHP\System\Utility"><span>Package</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Session</h1>


	<div class="description">
	SweetPHP<br />

<p><b>Session</b></p>

<p>Classe genérica para pegar, gravar e remover sessões.</p>
<br />

	</div>









	<div class="info">
		
		
		
		<b>Package:</b> <a href="package-SweetPHP.html">SweetPHP</a>\<a href="package-SweetPHP.System.html">System</a>\<a href="package-SweetPHP.System.Utility.html">Utility</a><br />

				<b>Copyright:</b>
				Copyright (c) 2013 - 2014, Ilines.<br />
				<b>Author:</b>
				sweetphp<br />
		<b>Located at</b> <a href="source-class-Session.html#3-186" title="Go to source code">libs/system/utility/Session.php</a><br />
	</div>



	<table class="summary" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="__construct" id="___construct">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___construct">#</a>
		<code><a href="source-class-Session.html#16-19" title="Go to source code">__construct</a>( )</code>

		<div class="description short">
			
		</div>

		<div class="description detailed hidden">
			







		</div>
		</div></td>
	</tr>
	<tr data-order="__destruct" id="___destruct">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#___destruct">#</a>
		<code><a href="source-class-Session.html#21-32" title="Go to source code">__destruct</a>( )</code>

		<div class="description short">
			SweetPHP<br />

<p><b>Session Destruct (__destruct)</b></p>

<p>Limpa todas as sessões do servidor</p>

		</div>

		<div class="description detailed hidden">
			SweetPHP<br />

<p><b>Session Destruct (__destruct)</b></p>

<p>Limpa todas as sessões do servidor</p>






				<h4>Author</h4>
				<div class="list">
						sweetphp<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="delete" id="_delete">

		<td class="attributes"><code>
			 public 
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_delete">#</a>
		<code><a href="source-class-Session.html#34-48" title="Go to source code">delete</a>( )</code>

		<div class="description short">
			SweetPHP<br />

<p><b>Session Delete (delete)</b></p>

<p>Limpa e destroi todas as sessões correntes no servidor</p>

		</div>

		<div class="description detailed hidden">
			SweetPHP<br />

<p><b>Session Delete (delete)</b></p>

<p>Limpa e destroi todas as sessões correntes no servidor</p>






				<h4>Author</h4>
				<div class="list">
						sweetphp<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="get" id="_get">

		<td class="attributes"><code>
			 public static
			type
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_get">#</a>
		<code><a href="source-class-Session.html#50-69" title="Go to source code">get</a>( <span>type <var>$sessionName</var> = <span class="php-keyword1">null</span></span>, <span>mixed <var>$remove</var> = <span class="php-keyword1">false</span></span> )</code>

		<div class="description short">
			SweetPHP<br />

<p><b>Session Get (get)</b></p>
 Retorna uma sessao conforme nome especificado na declaracao
		</div>

		<div class="description detailed hidden">
			SweetPHP<br />

<p><b>Session Get (get)</b></p>
 Retorna uma sessao conforme nome especificado na declaracao


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$sessionName</var></dt>
					<dd><code>type</code><br>$sessionName
<p>Nome da variavel de sessao</p>
 Usuario da sessao = (String) Paulo</dd>
					<dt><var>$remove</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>type</code><br>Session especificada, se nao existir sessao retorna false<br />
				</div>


				<h4>Author</h4>
				<div class="list">
						sweetphp<br />
				</div>
				<h4>Example</h4>
				<div class="list">
						$usuario = get("usuario"); echo $usuario = (String) Paulo<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="exists" id="_exists">

		<td class="attributes"><code>
			 public static
			type
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_exists">#</a>
		<code><a href="source-class-Session.html#71-86" title="Go to source code">exists</a>( <span>type <var>$sessionName</var> = <span class="php-keyword1">null</span></span> )</code>

		<div class="description short">
			SweetPHP<br />

<p><b>Session Exists (get)</b></p>
 Retorna uma sessao conforme nome especificado na declaracao
		</div>

		<div class="description detailed hidden">
			SweetPHP<br />

<p><b>Session Exists (get)</b></p>
 Retorna uma sessao conforme nome especificado na declaracao


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$sessionName</var></dt>
					<dd><code>type</code><br>$sessionName
<p>Nome da variavel de sessao</p>
 Usuario da sessao = (String) Paulo</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>type</code><br>Session especificada, se nao existir sessao retorna false<br />
				</div>


				<h4>Author</h4>
				<div class="list">
						sweetphp<br />
				</div>
				<h4>Example</h4>
				<div class="list">
						$usuario = get("usuario"); echo $usuario = (String) Paulo<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="put" id="_put">

		<td class="attributes"><code>
			 public static
			
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_put">#</a>
		<code><a href="source-class-Session.html#95-110" title="Go to source code">put</a>( <span>type <var>$sessionName</var> = <span class="php-keyword1">null</span></span>, <span>type <var>$value</var> = <span class="php-keyword1">null</span></span> )</code>

		<div class="description short">
			SweetPHP<br />

<p><b>Session Put (put)</b></p>
 Passa um valor para sessao
		</div>

		<div class="description detailed hidden">
			SweetPHP<br />

<p><b>Session Put (put)</b></p>
 Passa um valor para sessao


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$sessionName</var></dt>
					<dd><code>type</code><br>$sessionName
<p>Nome da variavel de sessao</p>
</dd>
					<dt><var>$value</var></dt>
					<dd><code>type</code><br>$value
<p>Valor que sera passado para a variavel de sessao</p>
</dd>
				</dl></div>



				<h4>Example</h4>
				<div class="list">
						$usuario = "Paulo"; put("usuario", $usuario);<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="remove" id="_remove">

		<td class="attributes"><code>
			 public static
			null
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_remove">#</a>
		<code><a href="source-class-Session.html#112-124" title="Go to source code">remove</a>( <span>type <var>$sessionName</var> = <span class="php-keyword1">null</span></span> )</code>

		<div class="description short">
			SweetPHP<br />

<p><b>Session Remove (remove)</b></p>
 Passa um valor para sessao
		</div>

		<div class="description detailed hidden">
			SweetPHP<br />

<p><b>Session Remove (remove)</b></p>
 Passa um valor para sessao


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$sessionName</var></dt>
					<dd><code>type</code><br>$sessionName
<p>Nome da variavel de sessao</p>
</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>null</code><br>se sessão existir<br />
				</div>


				<h4>Example</h4>
				<div class="list">
						remove("usuario"); $_SESSION (null)<br />
				</div>


		</div>
		</div></td>
	</tr>
	<tr data-order="removeAll" id="_removeAll">

		<td class="attributes"><code>
			 public static
			null
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_removeAll">#</a>
		<code><a href="source-class-Session.html#126-133" title="Go to source code">removeAll</a>( )</code>

		<div class="description short">
			
<p>remove all sessions current</p>

		</div>

		<div class="description detailed hidden">
			
<p>remove all sessions current</p>




				<h4>Returns</h4>
				<div class="list">
					<code>null</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="sessionArrayToObject" id="_sessionArrayToObject">

		<td class="attributes"><code>
			 public static
			null|<code><a href="class-Object.html">Object</a></code>
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_sessionArrayToObject">#</a>
		<code><a href="source-class-Session.html#135-146" title="Go to source code">sessionArrayToObject</a>( <span>type <var>$arraySession</var> = <span class="php-keyword1">null</span></span> )</code>

		<div class="description short">
			
<p>convert session to object std class</p>

		</div>

		<div class="description detailed hidden">
			
<p>convert session to object std class</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$arraySession</var></dt>
					<dd><code>type</code><br>$arraySession</dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>null|<code><a href="class-Object.html">Object</a></code></code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="objectToSession" id="_objectToSession">

		<td class="attributes"><code>
			 public static
			null
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_objectToSession">#</a>
		<code><a href="source-class-Session.html#148-163" title="Go to source code">objectToSession</a>( <span>type <var>$object</var> = <span class="php-keyword1">null</span></span>, <span>mixed <var>$sessionName</var> = <span class="php-quote">&quot;&quot;</span></span> )</code>

		<div class="description short">
			
<p>new session object</p>

		</div>

		<div class="description detailed hidden">
			
<p>new session object</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$object</var></dt>
					<dd><code>type</code><br>$object</dd>
					<dt><var>$sessionName</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>null</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="getObjectSession" id="_getObjectSession">

		<td class="attributes"><code>
			 public static
			null
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_getObjectSession">#</a>
		<code><a href="source-class-Session.html#165-184" title="Go to source code">getObjectSession</a>( <span>type <var>$object</var> = <span class="php-keyword1">null</span></span>, <span>mixed <var>$sessionName</var> = <span class="php-quote">&quot;&quot;</span></span> )</code>

		<div class="description short">
			
<p>new session object</p>

		</div>

		<div class="description detailed hidden">
			
<p>new session object</p>



				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$object</var></dt>
					<dd><code>type</code><br>$object</dd>
					<dt><var>$sessionName</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					<code>null</code><br />
				</div>




		</div>
		</div></td>
	</tr>
	</table>


















</div>

	<div id="footer">
		sweetphp API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>
